feat(core): Switch to MJML for email templates #10518
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
netroy
force-pushed
the
PAY-1807-mjml-templates
branch
from
ca6104a
to
60104fb
Compare
MarcL
reviewed
Aug 22, 2024
packages/cli/src/user-management/email/templates/passwordReset.mjml
Outdated
Show resolved
Hide resolved
MarcL
reviewed
Aug 22, 2024
n8n-assistant
bot
added
core
ivov
reviewed
Aug 23, 2024
There was a problem hiding this comment.
Thanks for tackling this!
- Button text doesn't look fully vertically centered.
- I think we've been moving to sentence case rather than title case throughout the app, esp. for button text.
- For dark mode we might want to add more contrast to the title color and the button text color.
packages/cli/src/user-management/email/templates/credentialsShared.mjml
Outdated
Show resolved
Hide resolved
packages/cli/src/user-management/email/templates/credentialsShared.mjml
Outdated
Show resolved
Hide resolved
| <mj-text>You have been invited to join n8n ({{domain}}).</mj-text> | ||
| <mj-text>To accept, please click the button below. </mj-text> | ||
| <mj-button href="{{inviteAcceptUrl}}"> Set Up Your Account </mj-button> | ||
| </mj-column> |
There was a problem hiding this comment.
Extra sentence/link somewhere explaining to the invitee what even is n8n?
packages/cli/src/user-management/email/templates/passwordReset.mjml
Outdated
Show resolved
Hide resolved
packages/cli/src/user-management/email/templates/workflowShared.mjml
Outdated
Show resolved
Hide resolved
| <mj-text font-size="24px" color="#ff6d5a"> A workflow has been shared with you </mj-text> | ||
| </mj-column> | ||
| </mj-section> | ||
| <mj-section background-color="#FFFFFF" border="1px solid #ddd"> |
There was a problem hiding this comment.
Not familiar with MJML, maybe there's a way to extract common styles to _common and use CSS classes instead?
There was a problem hiding this comment.
while it is possible, I've always struggled it do that in the past. Also, since these are emails, all those styles are likely to be inlined anyways.
I'd like to improve this whole setup, but perhaps in another PR.
packages/cli/src/user-management/email/user-management-mailer.ts
Outdated
Show resolved
Hide resolved
ivov
reviewed
Aug 26, 2024
packages/cli/src/user-management/email/templates/user-invited.mjml
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Looks like the higher contrast for dark mode didn't work?
There was a problem hiding this comment.
not sure how to fix this considering that this dark-mode is likely being done in the client. If I download the html email, and open it the browser, it renders fine in light mode.
packages/cli/src/user-management/email/templates/password-reset-requested.mjml
Outdated
Show resolved
Hide resolved
packages/cli/src/user-management/email/templates/workflow-shared.mjml
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Should we make exceptions for field name casing based on filename casing?
There was a problem hiding this comment.
I'm fine wither way. Do you prefer one way or the other?
There was a problem hiding this comment.
I'd prefer we stay consistent with camelCase, but not a blocker, can be addressed later.
packages/cli/src/user-management/email/templates/credentials-shared.mjml
Outdated
Show resolved
Hide resolved
|
LGTM, let's fix the conflicts and bring this in :) |
ivov
approved these changes
Aug 28, 2024
n8n
|
||||||||||||||||||||||||||||
| Project |
n8n
|
| Branch Review |
PAY-1807-mjml-templates
|
| Run status |
|
| Run duration | 04m 59s |
| Commit |
|
| Committer | कारतोफ्फेलस्क्रिप्ट™ |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
421
|
| View all changes introduced in this branch ↗︎ | |
|
✅ All Cypress E2E specs passed |
MiloradFilipovic
added a commit
that referenced
this pull request
Aug 28, 2024
* master: (24 commits) feat(core): Switch to MJML for email templates (#10518) fix(Gmail Trigger Node): Don't return date instances, but date strings instead (#10582) fix(core): Deduplicate sentry events using error stacktraces instead (no-changelog) (#10590) feat(editor): Implement new app layout (#10548) refactor(core): Standardize filename casing for services and Public API (no-changelog) (#10579) 🚀 Release 1.57.0 (#10587) fix(editor): Add tooltips to workflow history button (#10570) ci: Fix provenance generation during NPM publish (no-changelog) (#10586) feat(core): Expose queue metrics for Prometheus (#10559) refactor(core): Map out pubsub messages (no-changelog) (#10566) fix: Fix scenario prefix not being passed (no-changelog) (#10575) refactor(core): Convert `verbose` to `debug` logs (#10574) refactor(core): Use `@/databases/` instead of `@db/` (no-changelog) (#10573) ci: Fix destroy benchmark env workflow (no-changelog) (#10572) feat: Add benchmarking of pooled sqlite (no-changelog) (#10550) refactor(editor): User journey link to n8n.io (#10331) fix(Wait Node): Prevent waiting until invalid date (#10523) refactor(core): Standardize filename casing for controllers and databases (no-changelog) (#10564) refactor(core): Allow custom types on getCredentials (no-changelog) (#10567) fix(editor): Scale output item selector input width with value (#10555) ... # Conflicts: # packages/editor-ui/src/stores/assistant.store.ts
Merged
|
Got released with |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Our current email templates lack any style, formatting, semantic markup, etc. This is likely contributing a bit to our emails being marked as spam.
This PR migrates all our emails over to MJML to (hopefully) improve how our emails our perceived.
User Invitation email
Password reset request email
Workflow sharing email
Credential sharing email
Related Linear tickets, Github issues, and Community forum posts
https://linear.app/n8n/issue/PAY-1807
https://linear.app/n8n/issue/HELP-579
Review / Merge checklist